home *** CD-ROM | disk | FTP | other *** search
/ Aminet 16 / Aminet 16 (1996)(GTI - Schatztruhe)[!][Dec 1996].iso / Aminet / util / misc / Cookies.lha / Cookies / Cookies.doc < prev    next >
Text File  |  1996-09-19  |  10KB  |  272 lines
  1.  
  2. Cookies version 4.3
  3. ===================
  4.  
  5.  
  6. 1. What is Cookies?
  7. -------------------
  8. Cookies is two things:
  9. a/ A little fortune cookie program (can be quite funny)
  10. b/ A complete waste of disk space (it isn't particularly useful)
  11.  
  12.  
  13. 2. Installing Cookies
  14. ---------------------
  15. Umm, this is *really* tricky :-) Just drag the Cookies and Cookies.dat
  16. icons to where-ever you wanna put the program.  Works off floppy or
  17. hard drive.  There are no assigns to put in Startup-Sequence or
  18. anything.  This is a good thing because no-one would want to bother
  19. with assigns for a fortune cookie program.
  20.  
  21. In addition, if you want to use the program from Workbench, the
  22. reqtools.library must be installed in LIBS: Cookies needs version 38
  23. or above of reqtools.library.  This version has been included in the
  24. archive.  If you already have reqtools.library v38 or above installed,
  25. do *not* reinstall from this version.  However, if you do not have
  26. reqtools.library installed, or have an old version, you should copy
  27. the supplied version into your LIBS: directory.  The version supplied
  28. will work on all versions of AmigaOS from 1.3 up.  You must also have
  29. powerpacker.library version 33 or above.  A suitable version is
  30. supplied in this archive, if you don't already have one.
  31.  
  32.  
  33. 3. Using Cookies
  34. ----------------
  35.  
  36. A. From Workbench
  37.  
  38. Double click on the icon.  The program will check that Cookies.dat is
  39. in the current directory and will refuse to run if it isn't.  Assuming
  40. you followed the highly technical installation procedure outlined
  41. above, Cookies will open its window and display a random message from
  42. the text file.
  43.  
  44. The Cookies window has four buttons along the bottom; these are:
  45. ANOTHER   SPECIFIC   ABOUT   QUIT
  46.  
  47. Clicking ANOTHER will pick another cookie at random and display it.
  48.  
  49. By clicking SPECIFIC, you can pick a cookie from the file to display.
  50. It will open a window with a prompt in; you then enter the cookie
  51. number that you want.  For example, if Cookies.dat contains 100
  52. cookies, you can enter a number from 1 to 100.  So, if you have a
  53. lucky number, you can see which cookie it corresponds to!
  54.  
  55. Clicking ABOUT opens a window with the program credits in.
  56.  
  57. Clicking QUIT err... quits.
  58.  
  59. You can run Cookies from your WBStartup drawer.  Just drag its icon
  60. into the drawer, along with Cookies.dat.  WARNING: if you do this, you
  61. must delete Cookies.dat's icon using the Shell.  To recap: to run the
  62. program from WBStartup, the following three files have to go in the
  63. drawer:
  64.   Cookies
  65.   Cookies.info
  66.   Cookies.dat
  67. *NOT* Cookies.dat.info.  This will cause problems!  Also, make sure
  68. that Cookies.info has the DONOTWAIT tooltype set.
  69.  
  70. B. From Shell
  71.  
  72. Ensure that you are in the directory in which you have placed Cookies.dat.
  73. Type
  74.   cookies
  75. at the Shell prompt.  The program will pick a cookie, display it in
  76. the Shell window, and exit.  This is good for generating random
  77. .signature files for email.  You could put something like
  78.   cookies >S:.signature
  79. in your Startup-Sequence and have a different email signature every
  80. time you boot.
  81.  
  82. Cookies takes one switch from the Shell: WINDOW.  It instructs the
  83. program to act as if it is run from Workbench.  So you could do
  84. something like
  85.   run <NIL: >NIL: cookies window
  86. in your Startup-Sequence and have it run everytime you boot up, just
  87. for laughs!
  88.  
  89. If you run in the Shell without WINDOW mode on, it won't attempt to
  90. open reqtools.library, as the requester functions are not needed just
  91. for writing to the Shell.  So if you can't/don't/won't install
  92. reqtools.library, you can still use Cookies.  You lucky people! :-)
  93.  
  94.  
  95. 4. Cookies.dat file format
  96. --------------------------
  97. You put the messages one by one in the file, with a blank line between
  98. each one, and the cursor stopping on a blank line at the end of the
  99. file.  For example, a legal (but short) Cookies.dat would be:
  100.  
  101. No matter where you go, there you are.
  102.  
  103. "Doctor, Doctor, I've broken my arm in three places."
  104. "Then you shouldn't go to those places"
  105.  
  106. Life, don't talk to me about life...
  107. #
  108.  
  109. (The hash symbol represents where the cursor finishes up in the
  110. editor.  There are no lines after this).  The above file contains
  111. three cookies; the first and third have one line each; the second has
  112. two lines.  You may have up to nine lines per cookie.  Examine the
  113. included Cookies.dat to get to know the file format; it really is
  114. easy.  Once you've got to grips with it (which should take all of two
  115. seconds), you can add more cookies to it.  I keep mine in alphabetical
  116. order; this is not compulsory.
  117.  
  118. NOTE: if you have Cookies version 0.42 or below, you can simply rename
  119. your existing Cookies.txt file as Cookies.dat.  The formats are the
  120. same.
  121.  
  122. I got these cookies mainly from the fortune.txt file in with the
  123. NorthC distribution by Steve Hawtin.  I removed the rude ones and
  124. added some more.  I also changed the file format to make it easier (I
  125. think :-) to process.  My program code is not based in any way on
  126. Steve's; it is my own work.
  127.  
  128.  
  129. 5. Powerpacker support
  130. ----------------------
  131. Cookies.dat can be compressed with Nico François' Powerpacker, or any
  132. other cruncher that produces Powerpacker-compatible data files.  There
  133. are a number of PD Powerpacker-compatible crunchers available.  So all
  134. you Powerpacker freaks who like everything on your hard drive to be
  135. crunched can now have even more fun!  Plus, when a crunched
  136. Cookies.dat gets loaded, the pointer flashes in a cute fashion!  It's
  137. worth getting hold of a Powerpacker clone for this reason alone!  (or
  138. not... :-)
  139.  
  140. If you decide to crunch your Cookies.dat, then *DO NOT* append the .pp
  141. file suffix to it.  Cookies expects the file to be called Cookies.dat,
  142. and *NOTHING* else.
  143.  
  144.  
  145. 6. Bugs and limitations
  146. -----------------------
  147. Cookies.dat is limited to 65,535 cookies.  This should not be a problem
  148. for most people :-)
  149.  
  150. Cookies can be SLOOOOOOW from floppy disk.  Sorry :-(  It runs at a
  151. perfectly acceptable speed from hard disk.
  152.  
  153. Cookies has been tested under AmigaOS 1.3 and 3.1 It performed
  154. admirably.
  155.  
  156.  
  157. 7. History
  158. ----------
  159. - Cookies v0.1
  160. · Pitiful, bugged, lame... it worked (just); that was about all.
  161.  
  162. - Cookies v0.2
  163. · Now we are getting somewhere.  This version was cleaner.  There's a
  164.   lot wrong with it though - window opens quite big, no matter how long
  165.   the message.  You can only display one message; then you have to quit
  166.   and re- load (yawn).
  167.  
  168. - Cookies v0.21
  169. · A bug fix - the window title sometimes got corrupted.
  170.  
  171. - Cookies v0.22
  172. · The window now re-sizes around the message.
  173. · Some more bugs fixed, and lots of little changes to the code.
  174.  
  175. - Cookies v0.30
  176. · File handling is now a little faster, though not as fast as I'd
  177.   like...
  178. · Window initially opens as small as possible, and expands to accomodate
  179.   the message.
  180. · More memory efficient.
  181. · Text has 1 pixel extra space between lines (easier to read)
  182. · This is the first 'multiple-cookie' version - you can now load another
  183.   cookie by pressing the right mouse button when the window is active.
  184.   This is a time saver if you happen to be in a cookie mood.
  185. · Code reorganized using ARP library to make my life easier.
  186.  
  187. - Cookies v0.31 PUBLIC RELEASE
  188. · Got rid of ARP; I could manage okay without.
  189.  
  190. - Cookies v0.32 PUBLIC RELEASE
  191. · Code cleaned up a little; now a bit more efficient.  Functionality is
  192.   exactly the same as v0.31.
  193.  
  194. - Cookies v0.32a, b, c
  195. · Bug fixes and code cleanup.  Recompiled using AmigaOS 3.1 includes
  196.  
  197. - Cookies v0.4
  198. · First Reqtools version.  Now opens a nice window with buttons and stuff.
  199. · 'About' feature added
  200.  
  201. - Cookies v0.41 PUBLIC RELEASE
  202. · 'Specific' feature added
  203. · Now can print a cookie straight to Shell window, doesn't need reqtools
  204.   for this
  205.  
  206. - Cookies v0.42
  207. · Now buffers the entire Cookies.txt file into RAM if sufficient mem is
  208.   available.  This speeds up searching incredibly.
  209.  
  210. - Cookies v0.43
  211. · Powerpacker support added.
  212. · Cookies.txt renamed Cookies.dat, in recognition that it might be a
  213.   Powerpacker data file, not a text file, and so .txt might be a
  214.   misleading identifier, or something.
  215.  
  216. - Cookies v4.3 PUBLIC RELEASE
  217. · Functionally identical to v0.43, but renumbered in keeping with
  218.   standard Amiga software numbering schemes.
  219.  
  220.  
  221. 8. Plans for the future
  222. -----------------------
  223. Rewrite without Reqtools, using just Intuition stuff.
  224. Add support for Cookies.dat to be XPK compressed.
  225.  
  226.  
  227. 9. All about me
  228. ---------------
  229. I am a student with enough spare time to write useless programs in Pascal;
  230. I'm not actually wasting my time; this is good practice.  It also beats
  231. coding Amiga stuff in C, which is (1) confusing and (2) expensive.  This
  232. proggy was written in HS Pascal, which was not that cheap, but cheaper (and
  233. friendlier :-) than C.
  234.  
  235. If you wanna contact me, you can do so by email during University term time.
  236. Just point your mailer at:
  237.  
  238.   steffan@dcs.warwick.ac.uk
  239.  
  240. or you can send snail mail to:
  241.  
  242.   Stephen Williams,
  243.   9, Helmsley Way,
  244.   Spalding,
  245.   Lincolnshire,
  246.   PE12 6BG,
  247.   England.
  248.  
  249. I also have a World Wide Web page:
  250.  
  251.   http://www.warwick.ac.uk/~csuxg/
  252.  
  253. Please pass Cookies on to your Amiga-owning friends.  It's fun and, well,
  254. somebody might like it.  Perhaps.
  255.  
  256.  
  257. 10. Legal matters
  258. -----------------
  259. powerpacker.library, reqtools.library and associated development tools
  260. are copyright © by Nico Francois.
  261.  
  262. Cookies is copyright © by Stephen Williams (no, Steffan is not my
  263. real name :-)
  264.  
  265. Cookies is freeware.  It may be uploaded to bulletin boards and
  266. distributed by PD libraries, provided only a nominal charge is made
  267. for distribution.
  268. Cookies may not be included in any commercial package, including
  269. magazine cover disks, without the permission of the author.  Cookies
  270. is not in the public domain.  It may not be modified in any way.
  271. No-one may make any profit from Cookies.
  272.